Skip to content

docs: AGENTS.md: align commit subject format with SOF conventions#10713

Merged
lgirdwood merged 1 commit intothesofproject:mainfrom
kv2019i:202604-agents-git-commit-guidance
Apr 21, 2026
Merged

docs: AGENTS.md: align commit subject format with SOF conventions#10713
lgirdwood merged 1 commit intothesofproject:mainfrom
kv2019i:202604-agents-git-commit-guidance

Conversation

@kv2019i
Copy link
Copy Markdown
Collaborator

@kv2019i kv2019i commented Apr 21, 2026

Replace generic "feature: descriptive title" format with the actual SOF project convention "subsystem: component: short description" and add instruction to derive prefix from git log of modified files.

Replace generic "feature: descriptive title" format with the actual
SOF project convention "subsystem: component: short description" and
add instruction to derive prefix from git log of modified files.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
Copilot AI review requested due to automatic review settings April 21, 2026 13:13
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates contributor/agent guidance so commit subjects follow SOF’s established prefix convention instead of a generic feature: pattern.

Changes:

  • Replaces the documented commit subject format with subsystem: component: short description.
  • Adds guidance to derive the correct subsystem/component prefix using recent git log history of modified files, including concrete examples.

Copy link
Copy Markdown
Member

@lgirdwood lgirdwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kv2019i btw a follow up may be needed to enforce 80 char commit message.

@lgirdwood lgirdwood merged commit 1e9c28a into thesofproject:main Apr 21, 2026
44 of 45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants